Help Index
WINEDT 95  [Release 1.d] Help Index

Commands

Moving

Selecting

Undoing

Formatting

Highlighting

Delimiters

Command Line Parameters

TeX Specific Features

Licensing Agreement

Program Setup

Miscellaneous

Context Sensitive Help is provided for most of the Main Menu Commands, Input Dialogs, and Message Boxes.


WINEDT is a project manager and text editor for Windows 95.


Accelerator is a shortcut key that invokes a Menu Command. The Accelerators are displayed on the right of the appropriate Menu Item. Some Menu commands cannot be invoked through Accelerators.


Caret is a special symbol pointing to the insertion point (current position) of the text. The Blink Rate of the Caret can be set through Window's Setup Desktop Dialog. The shape and the size of the Caret is determined in the initialization file.


Cursor refers to the Mouse Cursor. Its shape is determined by Windows (depending on its position). Inside the editing window the cursor has an I-Beam shape.


Context Sensitive Help can be obtained by pressing the key "F1" while browsing through the Menu or while the Input Dialog or Message Box is having the focus.


MDI (Multiple Document Interface) is Window's Standard for certain applications using more than one (child) window. WINEDT uses an enhanced MDI interface.


Some editing commands only make sense in certain situations. For example Save File in File Menu command only makes sense if there is an open editing window. For user's convenience the commands that currently make no sense are disabled (resulting in a grayed Menu Item or Tool Bar Button).


Aleksander Simonic

E-mail address: 	alex@cs.dal.ca

Mail address:   	Dept. of Mathematics

  	Dalhousie University

  	Halifax, Nova Scotia

  	B3H3J5   Canada


Main Menu

Main Menu Commands:

File

Edit

Search

Format

Utilities

Documents

Project

Options

Window

Help

Some commands can be invoked through the Accelerator Keys displayed on the right of the corresponding menu line. Some commands can also be accessed through the Tool Bar. Commands are sometimes disabled.


File Menu

File Menu Commands:

 New         	Open a new editing Window

 Open...     	Open the existing file for editing

 Read...     	Open the existing file for reading only

 Update      	Update current window from the disk

 Save        	Save the current window

 Save All    	Save all modified windows

 Save As...  	Save the current file with a new name

 Close       	Close the current window

 Exit        	Close all windows and Exit

Before the window is closed the user is asked to save any changes if the file was Modified and its Status is not Readonly.


Edit Menu

Edit Menu Commands:

 Undo               	Undo the last Editing Command

 Redo               	Redo the last Undone  Command

 Undo All           	Undo All Commands

 Redo All           	Redo All Commands

 Reset Undo Buffer      	Release Memory...

 Paste              	Insert Text from Clipboard

 Erase              	Erase Text in Clipboard

 Cut            	Copy to Clipboard and Delete

 Copy               	Copy to Clipboard

 Append             	Append to Clipboard

 Delete             	Delete Selected Text


Format Menu

Format Menu Commands:

 Layout...           	Set Screen Layout

 Quick Format        	Format Current Paragraph

 Justify Selected Text...	Formatting Commands

 Move Selected Text...   	Move a Text Block

 Toggle Selected Text... 	Upper/Lower Case


Search Menu

Search Menu Commands:

 Find...        	Search:   String/Options

 Replace...         	Replace: Strings/Options

 Next               	Search/Replace Next Instance

 Prev           	Toggle Direction  +  Next

 TeX Errors         	TeX Error Recovery

 Set Mark           	Book Mark: Set

 Go to Mark         	Book Mark: GO TO

 Select  <--  Mark  	Book Mark: Select From

 Select  -->  Mark  	Book Mark: Select To

 Switch Scope...    	Book Mark: Scope

 Go to Line...      	Change Text Position

 ASCII Code...      	ASCII Code (Inquire/Insert)

 	          	(Selected/not Selected)


Utilities Menu

Utilities Menu Commands:

The only (default) Utilities Menu Command is:

Check Delimiters

Other Items in Utilities Menu are determined in the initialization file. The user can install the utilities that are commonly run with WINEDT.

The menu in TeX mode will probably look like:

TeX

LaTeX

BiBTeX

 ...

See also:

  Example Setup

  Program Setup


Utilities Setup

Utilities Setup Example:

The initialization file WEDTEX.INI should contain the following definitions to run DOS TeX applications in DOS-Window:

%Utilities:

>$111101011 + &TeX

c:\tex\bin\tex.pif &plain @P @F @E

TEX

>$111101012 - &LaTeX

c:\tex\bin\tex.pif &latex @P @F @E

TEX

>$111101013 + &BiBTeX

c:\tex\bin\bibtex.pif @P @F @E

BIBTEX

See also:

  Program Setup


Documents Menu

Documents Menu Commands:

 Text Statistics...  	Word Count and Similar

 Text Status...      	Low Level Data and Options

The user can install frequently opened documents and files associated with the current/main file.

The menu in TeX mode will probably look like:

TOC

BBL

Bibliography

See also:

  Example Setup

  Program Setup


Documents Setup

Documents Setup Example:

The initialization file WEDTEX.INI may contain the following definitions for fast access to certain files:

%Documents:

>$10100110: - &TOC  File

-R @P\@F.toc

TOC

>$10100110: - &BBL  File

-R @P\@F.bbl

BBL

See also:

  Program Setup


Project Menu

Project Menu Commands:

 Select...      	Select Project Related Options

 Add Main File    	Set Current Window as the Main File

 Remove Main File 	Remove the Main File

 Main File    	Edit the Main File


Options Menu

Options Menu Commands:

 Program Setup...

 Set Tabs...

 Auto Indent          	Automatic Identification

 Auto Wrap            	New Line when over margin

 Quick Format         	Enable Quick Format (F4)

 Update Files         	Update files from Disk

 Backup Files         	Create Backup on Save

 Enlarge Windows          	Enlarge Editing Windows

 Delimiter Limits     	Apply Line Limits

 Horizontal Bars      	Horizontal Scroll Bars

 Vertical Bars        	Vertical Scroll Bars

 Trim Lines           	Trim Spaces at the end of Line

 Trim Files           	Trim Empty Lines the end of File

 Syntax Highlighting      	Enable Syntax Highlighting

 Control Characters       	Allow Control Characters

 Translate Input      	Translate Keyboard Input

 Translate Output     	Translate Screen Output


Window Menu

Window Menu Commands:

 Enlarge

 Cascade

 Tile

 Arrange Icons

 Close All

The names of all opened files are appended to this menu.

Note: WINEDT is an MDI Application!


Help Menu

Help Menu Commands:

 Contents

 How to use Help

 Licensing Agreement

 About...

 Register...

Context Sensitive Help is provided for most of the Main Menu Commands, Input Dialogs, and Message Boxes.


Moving

Current position (insertion point) in the text is marked by the caret. In the Insert Mode the typed text is inserted at that point while the Overwrite Mode writes over the existing text. The user can toggle the mode by pressing the Insert Key.

The user can move the caret by using the mouse or one of the the Keys: Arrows, PageUp, PageDown, Home, End. If the moving command is combined with the Shift Key then the text between the old and the new position of the caret is Selected. Commands can also be composed with the Ctrl Key.

See also:

  Mouse

  Keyboard

  Scroll Bars

  Status Line

  Selecting


Moving: Keyboard

The Arrows Keys, PageUp, PageDown, Home, and End Keys move the caret exactly as the user should expect.

Ctrl+Up   	Ctrl+Down:       	next/previous paragraph

Ctrl+Left 	Ctrl+Right:      	next/previous word

Ctrl+Home 	Ctrl+PageUp:     	beginning of file

Ctrl+End  	Ctrl+PageDown:   	end of file

The following Key Strokes do not change the position of the caret inside the text but may move the current line:

ALT+End:         	Refresh the window

ALT+Home:        	-> center of the window

ALT+PageUp:      	-> top of the window

ALT+PageDown:    	-> bottom of the window

See also:

  Book-Marks


Moving: Book-Marks

The user can set and move to the Book-Marks inside the text using the commands in Search Menu.

The last 64 positions of the caret is stored in a ring buffer and they can be accessed through Ctrl+Backspace and Ctrl+Shift+Backspace key strokes.


Moving: Mouse

After positioning the (I-Beam) Mouse Cursor anywhere in the editing window the user can move the caret to this position by clicking the left button. Double-clicking the left button results in the closest word to the cursor being selected and the caret moves to the beginning of this word.

Clicking the Right Button selects the word on the right of caret without changing its position. This is useful if the user cannot see the caret after switching between different windows. Double-clicking the right button results in centering the current line in the window without changing caret's position in the text.

Note the difference between the Cursor and the Caret.


Moving: Scroll Bars

Windows' Scroll Bars are provided for faster moving through large files. The user can specify whether or not the editing windows should have vertical and horizontal scroll bars in the initialization file and through the Options Menu.

Changing the settings in the Options Menu has no effect on the windows that are already opened.


Moving: Status Line

The position in the current window is displayed in the first box of the status line which is at the bottom of the main window. The current position is:

 <line>:<column>

The Second Box displays the total number of lines in the current window. The status line also contains the following information about the current window:

Text Status

Editing Mode

Time and Date

Editor Status


One of the following:

New

Readonly

Modified

<Unmodified>


One of the following:

<Idle>  	Normal Mode

Working 	Can be Cancelled

Locked  	Pause Key...


One of the following:

Insert

Overwrite

Press the Insert Key to toggle the Mode.


Current Time and Date:   HH:MM    DD-MMM-YYYY.

Since the current time is displayed in Win95's Task Bar

WINEDT 95 does not display the time...


Selecting

Some Editing Commands (such as copying to the clipboard or formatting) apply only to the selected text.

WINEDT follows the Window's Applications standards:

to select a part of the text use any of the moving commands while holding the "Shift" key.

By default the selected text is displayed in reverse (the mode of displaying selected text can be changed by modifying the initialization file). Most of the commands will reset the selected text.

Note: The commands that require selected text as a parameter are enabled only after the text has been selected.


Undoing

All Editing Commands can be undone using the Undo Command in Edit Menu. After a set of commands is undone it can be redone using the Redo Command.

Information necessary for "undoing" and "redoing" is stored in the Undo Buffer. User can specify the size of the Undo Buffer in the initialization file. WINEDT will keep information until the Undo Buffer is full. After that some of the information is forgotten. The state of the Undo Buffer can be inspected by Text Status Command. The user can Reset Undo Buffer, using the Reset Undo Buffer Command, and thus releasing some memory.


Formatting

Although WINEDT is a text editor it has a few primitive formatting commands built in to help you maintain readability of your text after modifications.

The format dialog allows you to set parameters such as left and right margin for formatting command(s). Most formatting commands apply to selected text only. The right margin also affects the "Auto Wrap" in case this Option is enabled.

Try different Formatting Commands in Edit Menu!

Note: Formatting commands (except for Quck Format [F4]) are enabled only after the text is selected!

See also:

  Selecting


Delimiters

WINEDT has a built-in-procedure that checks the Delimiters. The left and right delimiters together with certain characteristics are specified in the initialization file. The program also checks LaTeX environments:

\begin{environment} ... \end{environment}.

If WINEDT detects an error it displays a message stating the nature of an error; the cursor is positioned at the place where the error occurred making it easy for the user to fix it. Sometimes WINEDT itself can fix an error. Checking the Delimiters before running TeX may save a lot of time.

See also:

  Checking Scope

  Checking Mode

  Quotes

  Examples

  Program Setup


Delimiters: Quotes

TeX quotes: ``Quote'' are checked together with other Delimiters. If this is not desirable the user should remove the lines of the "%Delimiters:" group in the initialization file (wedtex.ini) defining ` and ' as Delimiters.

Similarly, $ and $$ for text and displayed math can be removed.

The F6 Key will insert the sequence `` if the text position is in the beginning of the word or '' otherwise.


Delimiters: Examples

Type the following examples and try different modes of Delimiters Checking.

  $$ {\sum_k=1^n \frac1n = \infty} $

  Text Math: $a+b > 0

  ``This is a quote.''

\begin{equation}

  \Delta_A(f) = A\left(f_0+\tfracr\sqrt1-r^2g)

Hint: Inserted Delimiters can be removed by undoing the last action!


Delimiters: Mode

Delimiters Checking can be invoked either by selecting the Check Delimiters command in Utilities Menu or by using accelerator F7 combined with Shift and Alt Key.

"Shift" Key enforces slow mode while "Alt" Key results in the attempt to append missing delimiters (if any) at the end of the scope.

In slow mode the Delimiters are selected (in the colors determined in the initialization file). Try it and see the examples!

Ctrl+C or Ctrl+Break will interrupt the procedure (useful in a slow mode if the scope is too big).


Delimiters: Scope

The scope to which the Delimiters Checking applies is determined automatically unless the user selects the text before invoking the Delimiters check command.

If the cursor is at the beginning of the file then the scope is the entire file and the procedure will work in a fast mode (without tracking the position).

If the cursor is positioned in the non-selected text then the scope is usually from the beginning of the paragraph or the environment to the cursor position.

If you want to state the scope explicitly select it using the Text Selecting Commands.


TeX Specific Features

If WINEDT is initialized with wedtex.ini (TeX Mode) then it supports some features specific to TeX. Beside the delimiters checking and automatic insertion of missing Delimiters and environment terminators (see Delimiters) the program enables fast and easy TeX Error Recovery.

The program can read the LOG file produced by TeX or LaTeX and parse it for Errors. Pressing F2 key will usually result in the appropriate default action. Try it!

See also:

  [La]TeX Errors

  Error Types

  Error Mode

  Input

  Program Setup


TeX Errors

WINEDT can read the LOG file produced by TeX or LaTeX and parse the file for errors. The name of the LOG file is determined depending on the input for TeX.

Pressing F2 key will usually result in the appropriate default action. WINEDT keeps track of the modifications of LOG file and consecutive errors are processed by pressing F2. Depending on the nature of error the text will be positioned and highlighted. The upper part of the screen displays information in the LOG file while the lower part of the screen displays the window containing the TeX source file. The best way to see how Error Recovery works is to try it!

The Errors are determined in the initialization file.

See also:

  Program Setup


TeX Errors: Input

If you are working on a large project using the Main File it is important that LOG file contains information that tells WINEDT to which input file does an error refer. For these purpose the lines starting with ":" are treated as an escape sequence that helps WINEDT in keeping track of the Current Input File.

Example: Suppose your Main File includes an Introduction and a few Chapters, each contained in their own file. The following lines in the Main File enable WINEDT to keep track of the input files:

   ...

\chapter*{Introduction}

\typeout{:<+ intro.tex}  %Input Stack -> intro.tex

\input intro.tex

\typeout{:<-}  %Input Stack <- Back to the Main File

   ...


TeX Errors: Error Types

WINEDT recognizes five types of Errors.

Errors of type 1 are the most common (for example undefined control sequences). WINEDT is usually able to position to the exact place where the error occurred.

Errors of type 2 include over-full boxes and WINEDT is only able to find the paragraph where such a box occurred.

Finally Errors such as undefined LaTeX references or citations are located through the Editor's Find command and after they are located the user can keep on searching for the string using the "Next" and "Prev" command in the Search Menu.

A definition of errors of types 1...5 is determined by the initialization file. The file WEDTEX.INI contains the most common errors for LaTeX2e.


TeX Errors: Error Mode

The Error Mode is determined by specifying which types of errors should be processed and which are ignored. The user can change the Error Mode in different parts of the text using the command

\typeout{:?abcde}

where a...e have the value 1 or 0 depending on whether processing the errors of type 1...5 (respectively) is enabled.

Example: The front matter in LaTeX "thesis" format produces a lot of under-full boxes which can be ignored. The file thesis.tex should include the following command causing WINEDT to ignore these errors (warnings):

   ...

\typeout{:?00000} % Disable Error Processing

\beforepreface % Produce Title Pages ...

\typeout{:?11111} % Enable  Error Processing

   ...


Licensing agreement

WINEDT 95 is shareware. The program may be used for an evaluation period of two weeks. Any further use requires a license from the author obtained through the Registration procedure.

This software cannot be sold without written authorization from the author. You may not decompile, disassemble, reverse engineer, or modify this software. This includes, but is not limited to, modifying or changing any icons, menus, or displays associated with the software.

The author of this program accepts no responsibility for damages resulting from the use of this software and makes no warranty, either express or implied, including but not limited to, any implied warranty of fitness for a particular purpose. This software is provided as it is, and you, its user, assume all risks when using it.

See also:

  About WINEDT 95

  Registration


Registration

WINEDT 95 is shareware and you are supposed to register your copy. The program may be used for an evaluation period of two weeks. Any further use requires a license from the author obtained through the registration procedure. Contact the author by e-mail if you would like to register your copy. Don't forget to include your full name and affiliation!

After you receive the registration number corresponding to your name, enter your name and the number in the appropriate boxes of the registration dialog.

There is a fee of US $25 associated with the registration of WINEDT 95. If you want to register your copy contact the author by e-mail:

  alex@cs.dal.ca   (Subject: WINEDT 95  [Release 1.d])


About WINEDT 95

WINEDT is an MDI based editor for Windows 95. The program is designed to provide an integrated environment for Windows or DOS based applications that require ASCII input. WINEDT 95 can handle HUGE files.

Although the program can be used in many ways it is particularly suitable for managing TeX and LaTeX documents and projects. The program is designed for users that have some basic experience with Window's applications and TeX related software (such as DVI Driver, Spell Checker, TeX, LaTeX...) which is available on FTP sites. The author will provide assistance to registered users to setup the TeX environment that runs with WINEDT.

See also:

  Program Setup


Command Line Parameters
WINEDT can be invoked with the following command line parameters and qualifiers:

-E=<INI_File>

-C=<Caption>

-c=<Caption>

-G=(<scr>,<line>,<column>)

-S=(<sel>,<line>,<column>)

-T=<TABS>

-R/-r 	Readonly file

-P/-p 	Main (project) file

-M/-m 	Maximize the next window

-I/-i 	Ignore non-existing files

-A/-a 	Append to the existing window

-H/-h 	Syntax Highlighting: On/Off

<file1> <file2>     ... input files

See also:

Program Setup


Input Parameters

Input

Each input file specified in the command line is read and displayed in a separate MDI window.

Example:  You can create an icon that calls WINEDT in order to inspect or modify the DOS configuration files:

  winedt -C=DOS_System_Files c:\autoexec.bat c:\config.sys


Command Line Parameters: -G=(<scr>,<line>,<column>)

GOTO: -G=(<scr>,<line>,<column>)

GOTO <line>:<column> and center the line in the screen if <src> parameter is 1 or leave the default position otherwise.

If line or column is preceded by "+" or "-" then the new position is determined relatively with respect to the current position within the text.

This command was added in order to implement DVIWIN 2.9 Inverse Search.


Command Line Parameters: -S=(<scr>,<line>,<column>)

Select: -S=(<sel>,<line>,<column>)

Select the text between the current position and <line>:<column>. The text is displayed according to <sel> attribute between 0 and 15. For more information about different selection modes see "%Select:" group in Setup.

If line or column is preceded by "+" or "-" then the selection position is determined relatively with respect to the current position within the text.

This command was added in order to implement DVIWIN 2.9 Inverse Search.


DVIWIN 2.9

DVIWIN

DVIWIN is a (celebrated) DVI Driver for Window's 3.1 and WindowsNT written by H. Sendukas.

The DVIWIN 2.9 "Inverse Search" will work fine with WINEDT if "Uses DDE" option is disabled and the "Command Line" is defined as:

    winedt -E=wedtex.ini -C=WINEDT_-_TEX

       $f -G=(1,$l,0) -S=(8,+1,0)

The Initialization File "wedtex.ini" also contains a command for DVIWIN Search. It is user's responsibility to make sure that TeX produced the "src" specials required for (Inverse) Search. See DVIWIN 2.9 documentation (and demo.tex file) for more information on this topics.


Command Line Parameters: -E

Initialization File

The behavior of WINEDT is mostly determined by the data in the initialization file. By default the program reads the file WINEDT.INI in the path directory. However, if the first parameter in the command line is -E=<INI_File> then the default initialization file is replaced by the specified file.

WINEDT comes with the following initialization files:

 winedt.dat 	Examples

 winedt.ini 	Plain Mode

 wedtxt.ini 	Text Mode

 wedtex.ini 	[La]TeX Mode

See also:

Program Setup


Command Line Parameters: -T=<TABS>

Setting the TAB Expansion

This option sets the TAB Expansion. Note that the TAB characters are treated depending on this setting. In particular, if the user does not want the TAB characters to be expanded the option

 -T=1

should precede the opening of a file. A default setting is determined by the initialization file.

See also:

Setting Tabs

Program Setup


Command Line Parameters: -C

Caption

The window Caption is set to the specified string. If the window with that caption already exists then WINEDT gives focus to the existing application and quits after sending the Command Line Parameters to the active application.

The string must consist of a single word. For that purpose the underline character "_" gets translated into a space. A Default Caption (in the absence of -C or -c options) is determined in the initialization file.

Example:  If you are working on your thesis you will likely create an icon in your TeX Group containing the following command line (and the appropriate default directory):

 winedt -E=wedtex.ini -C=WINEDT_-_TEX:_Thesis thesis.tex


Command Line Parameters: -c

Caption

The same as -C=<Caption> except that in this case a new instance of WINEDT is created regardless of whether the window with the same caption exists or not.


Command Line Parameters: -R/-r

Readonly Files

The files following -R qualifier are assumed Readonly. The files following -r qualifier (default) are not assumed Readonly.

If the file Status is Readonly the program does not ask to save any changes on exit. The status can be changed using the "Text Status..." Dialog Box in Documents menu.


Command Line Parameters: -P/-p

Project and Main File

The qualifier -P enable the Main File Option while -p disables it. Some applications installed to run with WINEDT (such as TeX or LaTeX) require an input file. If The Main File Option is enabled then the input is the Main File while in the absence of Main File Option the input is the file in the current window.

Unless reset (using the commands in Options/Project Menu) the Main File is the first file being opened. The -P or -p qualifier redefines a default setting in the initialization file.

See also:

Program Setup


Command Line Parameters: -M/-m

Maximize MDI Windows

The qualifier -M maximizes the MDI Window opened next. The -m causes the window to be positioned and sized according to the settings in the initialization file.

This option is hardly ever needed.

See also:

Program Setup


Command Line Parameters: -I/-i

Ignore non-existing files

If the file specified in the command line cannot be opened (does not exist) then WINEDT issues a Warning Message. The Qualifier -I makes WINEDT ignore such files without any message while -i results in the (default) Warning Message.

This option is hardly ever needed.


Command Line Parameters: -A/-a

Multiple copies

If the file specified in the command line is already opened then WINEDT gives focus to the child containing this file instead of opening another copy. Qualifier -A ensures such (default) behaviour while -a causes a new copy to be opened.

This option is hardly ever needed.


Command Line Parameters: -H/-h

Syntax Highlighting

This qualifier overwrites the default Syntax Higlighting Option as specified in the initialization file.

This option is hardly ever needed.


Input Dialog: Enter Number

You are expected to enter an integer in the specified range. The current (default) value of the parameter is initially displayed selected in the edit line.

If you do not want to make any changes press the ESC key or click the Cancel button.


Input Dialog: Switch Bookmark

You can use nine book-marks in your file. See commands in Search Menu. Usually one mark will suffice. However, you can switch to another scope if needed for setting a new book-mark without overwriting the existing one.

The editor remembers the last 64 positions which are stored in a ring buffer and can be invoked by Ctrl+Backspace and Shift+Ctrl+Backspace key strokes.

Try it!


Input Dialog: Set Tab

TAB Characters are usually expanded into Spaces. When the file is initially read the conversion is automatic and it depends on the Tab Setting.

Setting 	Expansion

-----------------------------------------------------------------------

0       	TAB Characters Ignored

1       	TAB Characters Included

> 1     	Aligned (modulo Tab Setting)

< 0     	Fixed   (absolute value of Tab Setting)


Input Dialog: Go To Line

After entering a new line the caret moves to the new line (while preserving the column position).

The current line is initially displayed selected in the edit line.

If you do not want to make any changes press the ESC key or click the Cancel button.


Input Dialog: File Save

This dialog is invoked whenever a new file should be saved on the hard drive or the existing file is saved using "Save As..." command in File Menu.

Choose the appropriate drive/directory and enter a file name. If the file already exist you will be asked whether you want to overwrite it.

If you do not want to save the file press the ESC key or click the Cancel button.


Input Dialog: File Open

This dialog allows you to choose the file to be read or edited in a new window.

After selecting a file press the Enter or click the OK button.

If you do not want to open a file press the ESC key or click the Cancel button.


Input Dialog: Search

This dialog allows you to specify a string to be searched in a current window.

The dialog allows you to specify a few options in the form of check boxes. Normally the search procedure will stop at the end or the beginning of the file (depending whether the direction is set Forward or Backward). However, if you choose Cyclic Search the search will continue from the bottom or top.

If the specified string is found it is displayed in a selected mode. Otherwise a Message is displayed stating that the string was not found.

See "Next" and "Prev" commands in Search Menu.


Input Dialog: Replace

This dialog allows you to specify a string to be replaced by another specified string.

The dialog allows you to specify a few options in the form of check boxes.

See "Next" and "Prev" commands in Search Menu.


Input Dialog: Format Setup

Although WINEDT is a text editor it has a few primitive formatting commands built in to help you maintain readability of your text after modifications.

The format dialog allows you to set parameters such as left and right margin for formatting command(s). All formatting commands apply to selected text only. The right margin also affects the "Auto Wrap" in case this Option is enabled.

See: Options Menu.

Note: Formatting commands are enabled only after the text is selected!

See also:

  Selecting

  Formatting


Input Dialog: Registration

WINEDT 95 is shareware and you are supposed to register your copy. If you would like to register contact the author by e-mail:

  alex@cs.dal.ca     (Subject: WINEDT 95)

After you receive the registration number corresponding to your name enter your name and the number in the appropriate boxes of the registration dialog.

You are then a registered user of WINEDT 95!

See also:

  About WINEDT 95

  Registration

  Licensing Agreement


Input Dialog: Project

WINEDT has a simple but efficient way of handling the projects. It allows the user to specify the Main File. If the Main File Option is enabled then the programs that require input (such as TeX) get the main file as a parameter. By default the first opened document is assumed to be the main file in TeX-MODE.

See also:

  Program Setup

  Command Line Parameters


Input Dialog: Text Status

This dialog displays some information about the text in the current window. The user can change the status of a file if there is any reason for doing so.

If the file in the current window has changed (the output of some other application) then in the case the Update Option in Options Menu is enabled and the Update box in the dialog is checked the user will be asked whether or not to update the window with the new version.

This is often useful when working with certain applications that change the file on the hard drive (for example: Spell Check).


Static Dialog: Text Info

This dialog displays information such as word count and other characteristics of the text in the current window.

Since WINEDT is primarily designed to work with TeX it displays some TeX specific information. If the source is not a TeX input ignore this information.


Static Dialog: About

This dialog displays the information regarding the current version of the program. It also displays the registered user's name.

See Registration in order to register.

The program also displays the available memory resources which is a useful information in the case when you suspect that the system is getting unstable due to the memory related problems.


Message Box: Memory Warning

Running the program with insufficient memory might result in a non-recoverable error. If the Memory Warning Message was displayed you are advised to quit a few applications in order to increase the available memory. Also, some actions such as a global replace on a huge file may become painfully slow.

The program should run fine with 4MB memory and Windows 95. However, since the program was developed and tested on a system with 8MB it is possible that the memory related problems will occur in the case of running too many applications with little memory.

Hint: Consider Resetting the Undo Buffer!


Message Box: Buffer Length Exceeded

WINEDT is a text editor. It is a bad practice to have lines longer than 1000 characters (for example most TeX implementations refuse to read such text).

WINEDT can read most of the standard text formats and allows any combination of <CR>/<LF> as a line terminator. The output always has <CR><LF> sequence as a line terminator.


Message Box: Line Number Exceeded

WINEDT does not allow the input file to be longer than 16,000,000 lines. The reasons for this limitation are of technical nature. However, it is very unlikely that you want a file longer than the above mentioned limit.

If you want to work with files longer than 16,000,000 lines try to split them into smaller files using some other program.


Message Box: Info

This Message Box displays an Info message. Read it carefully and decide on the next action.


Message Box: Error

This Message Box displays an Error message. Read it carefully and decide on the next action.


Message Box: Error - INI

This Message Box indicates that the initialization file contains error(s). You should find an error and fix it. Read the help on Program Setup if necessary!

As a consequence of the error the program is likely not going to act the way you expect. Use the Setup command in Options Menu to edit the initialization file.


Message Box: Error - Fatal

This Message Box displays an Fatal Error message. Read it carefully and decide on the next action.

Hint: Fatal Error is probably a consequence of modifications made to the initialization file. Restore the old version of the file and carefully check the changes made.

 Check also the memory resources. You can reset the Undo buffer to release some memory...


Message Box: Registration Delay

This Copy of WINEDT is not registered. Please WAIT!

If you want to eliminate this message and the associated delay, please register!

See also:

  About WINEDT

  Registration

  Licensing Agreement


Message Box: Illegal Registration

This Copy of WINEDT is not properly registered. If you want to eliminate this message please register!

See also:

  About WINEDT

  Registration

  Licensing Agreement


Message Box: Registration

This Copy of WINEDT is not registered. If you want to eliminate this message please register.

See also:

  About WINEDT

  Registration

  Licensing Agreement


The Input Dialog allows you to enter/change certain parameters.

If you do not want to make any changes press the ESC key or click the Cancel button.


The Static Dialog displays certain information.

To exit click the OK button or press Enter.


The Message Box displays a message (Info, Warning, Error, or Fatal Error). Read the message carefully and decide on the next action.

To exit click the OK button or press Enter.


Program Setup

WINEDT uses the initialization file to set the default values of certain parameters and to set-up utilities (applications) and documents. The initialization file can be modified (as a text file) through the Program Setup Command in the Options Menu.

Please, read the following before attempting any changes:

  Getting Started

  Syntax

  Groups

  Customizing

  Installing

  Tool Bar

  Errors

  Hints


Setup: Getting Started

The user may never need/want to change any settings in the initialization file except for installing utilities and documents. Since this is a very non-frequent action this version of WINEDT is not designed for user-friendly modifications of the initialization file. The file is simply edited as a text file and the changes are effective upon restarting WINEDT.

The file WINEDT.DAT contains examples on how to modify the file and install the most common utilities. The user should consult this samples when customizing the program for particular applications and then proceed with care, making one change at the time.

Note that through the Menu Commands many options and settings can be changed while running the program. However, this will not affect the (default) values in the initialization file.


Setup: Syntax

The parameters in the initialization file are split into GROUPS. Although the user is allowed to set almost all parameters, there is hardly any need to change the defaults except when it comes to the installation of utilities and documents.

Each group looks like:

%<GROUP_NAME>: [Comment]

<Group specific Parameters>

       ...

<EMPTY LINE>

See the file WINEDT.DAT for comments and more detailed description of the parameters set in each of the groups.


Setup: Groups

This are all the GROUPS allowed in the initialization file:

  %Caption:    	%Defaults:

  %Output: 	%Input:

  %Options:    	%Utilities:

  %Documents:  	%Tools:

  %Speed Bar:  	%TeX:

  %Errors: 	%Delimiters:

  %Font:   	%Size:

  %Colors: 	%Select:

  %Search:     	%Setup:

  %Caret:  	%Highlighting:

  %Memory:     	%Menu:

See the file WINEDT.DAT for comments and more detailed description of the parameters set in each of the above groups.


Setup: Customizing

The user may want to customize WINEDT for different purposes. In that case a new initialization file should be created and an icon calling WINEDT with the first parameter -E=<INI_File> should be defined.

The initialization files included with this distribution contain different examples (from plain text editor to TeX based integrated environment). The user should place the utilities in the appropriate directories and check that the proper utility is invoked by the command in the initialization file.

A routine search for the string "c:\" will place you to the point in the initialization file where certain application is defined. You can change the directory and the file name or remove the definition of that utility in the case it is not wanted.


Setup: Toll Bar
Setup: Tool Bar

The user can call certain common commands by clicking a button in the tool bar. Holding the (left mouse button) down, while the (arrow) mouse cursor is on the button, displays the meaning of that button in the status line. Releasing the left button while the message is displayed results in the appropriate command being executed.

The user should hold a button at least for a fraction of a second otherwise the command is ignored.

See also:

  Types of Buttons

  Buttons: Menu Commands

  Buttons: Utilities/Documents

  Arranging the Buttons

  Examples


Setup: Toll Bar - Types of Buttons
Setup: Tool Bar - Types of Buttons

There are three types of buttons in the Tool Bar:

Buttons from 0..15 (Type 0) have a fixed meaning corresponding to the Menu Commands. There is no need for the user to change anything except (possibly) the text displayed in the status line while the button is being pressed. If the menu command is temporarily disabled then the corresponding button as well as the menu command are both grayed and the command is ignored.

Buttons from 16..22 can be associated with the Items in Utilities Menu (Type 1) or Documents Menu (Type 2). Unlike the buttons corresponding to the Menu Commands this buttons never get enabled/disabled by WINEDT (depending on the meaning of the command). Therefore it is important that all the buttons of Types 1 and 2 are initially enabled.


Setup: Toll Bar - Arranging the Buttons
Setup: Tool Bar - Arranging the Buttons

The buttons defined in the %Tool: group can be arranged in any order in the Tool Bar. The Group %Speed Bar: contains the index off all the buttons included (arranged from left to right):

Example:

  %Speed Bar: ; The Tools in the Speed Bar

  0 1 2 3 4 5 6 7 8 9 10 11 13 14 15 21 18 20 19 16 17

Note:  The group %Tools: must precede the group %Speed Bar: in the initialization file. While the buttons can be omitted they are not allowed to be repeated in the Tool Bar. The buttons that were not previously defined cannot be included in the Tool Bar and an attempt to do so will result in an error message during initialization. If the group %Speed Bar: is followed by an empty line then the Tool Bar is empty.


Setup: Toll Bar - Menu Commands
Setup: Tool Bar - Menu Commands

Button:  0 	 	About WINEDT...

Button:  1 	 	Text Statistics...

Button:  2 	 	Update

Button:  3 	 	Save

Button:  4 	 	Close

Button:  5 	 	Find...

Button:  6 	 	Next

Button:  7 	 	Cut

Button:  8 	 	Copy

Button:  9 	 	Paste

Button: 10 	 	Undo

Button: 11 	 	Redo

Button: 12 	 	TeX Errors

Button: 13 	 	Check Delimiters

Button: 14 	 	Add Main File

Button: 15 	 	Remove Main File


Setup: Tool Bar - Utilities/Documents

Button: 16

Button: 17

Button: 18

Button: 19

Button: 20

Button: 21

Button: 22

The buttons 16..22 are available for utilities (Type 1) and documents (Type 2) .

See also:

Examples


Setup: Tool Bar - Examples

Assuming that LaTeX and BiBTeX are the second and the third utility (respectively) defined in %Utilities: Group, and Print is the first Utility in %Documents: Group, this is a possible definition for corresponding buttons in the Tool Bar:

%Tools: > Index  Type  Enabled  Menu_Item    Text

              ...

>  18 1 1 1    LaTeX

>  21 1 1 2    BiBTeX

>  16 2 1 0    Print Current File

Note: Menu Items start with index 0. Utilities and Documents must be previously defined in "%Utilities:" and "%Documents:" groups.

See WINEDT.DAT for more examples.


Setup: Installing Utilities and Documents

WINEDT can run Windows and DOS applications, passing the parameters depending on the current window or main file. The user should first install an application such as TeX, DVI Driver or Spell Checker. An application or a document can be put either in the Utilities Menu or the Documents Menu.

See also:

  Syntax

  Utilities

  Documents

  Options Mask

  Accelerators

  Parameters

  Examples

  WINEDT.DAT


Setup: Install - Syntax

A Utility or Document definition contains 3 lines (possibly preceded by a comment line starting with ";").

Example:

;Definition of TeX

>$111101013 - &TeX

c:\tex\bin\tex.pif &plain @P @F @E

TEX

See also:

  Line 1

  Line 2

  Line 3


Setup: Install - Syntax (Line 1)

The characters ">$" are followed by a binary Options Mask ending by ":" or an Accelerator's index. The Accelerator is inserted on the right of the Menu Item.

The character "+" or "-" determines whether or not the Menu Item is preceded by a separator (the space before and after this character is ignored). The rest of the line is the Menu Item (note that a character preceded by "&" is underlined and serves as a shortcut to access an item in the menu).


Setup: Install - Syntax (Line 2)

The second line contains a string that defines a utility or a document with Parameters depending on the current input.

Utilities Examples:

c:\tex\bin\tex.pif &plain @P @F @E

c:\tex\bin\tex.pif &latex @P @F @E

c:\tex\dviwin\dviwin.exe @P\@F

Documents Examples:

@P\@F.tex

-R @P\@F.log

c:\tex\bib\xbib.bbl


Setup: Install - Syntax (Line 3)

This line contains the Caption (Title) of the Window.

If the Append Option in the Option's Mask is set to YES then WINEDT appends to this application rather than creating a new instance. Note that the title can contain parameters depending on the current input.

This line is ignored (but must be present) if the definition refers to a document rather than a utility.


Setup: Installing Utilities

The Window's applications are installed by specifying the path and the name of the application and passing the INPUT parameters.

It is highly recommended that the DOS applications are invoked through the ".PIF" shortcut file. That way the user can specify whether to run them in a Window or full-screen and possibly set some other parameters...

The example of TEX.PIF and TEX.BAT file is included in this distribution. The user should find it easy to modify these two files in order to run the installed version of TeX (the only things that have to be changed depend on the path where the TeX applications are). The files TEX.PIF and TEX.BAT can be used as a prototype for the installation of other DOS applications.


Setup: Installing Documents

The documents are treated similarly as utilities except that they are displayed in WINEDT editing window (assumed to be ASCII text files). The user can define the most frequently used documents as well as the documents associated with the current or main file (such as ".LOG" or ".TOC" files for LaTeX applications).

Usually Documents are placed in the Documents Menu and can also be associated with the Tool Bar Buttons (Type 2). The line containing the definition of a document can also contain all Qualifiers (with the exception -E) that can be passed as Command Line Parameters. One menu command can open more than one document (in fact after translating the "@" parameters the definition of a document is treated the same way as the Command Line).


Setup: Install - Accelereators

Setup: Install - Accelerators

The user can associate the following accelerators to any of the items defined in the Utilities or Documents Menu:

Index    	Key     	Index    	Key

----------------------------------------------------------------------------------

0    	Left+Alt+Shift  	8    	F12+Alt

1    	F9      	9    	F11

2    	F9+Shift    	A    	F11+Shift

3    	F9+Ctrl     	B    	F11+Crtl

4    	F9+Alt      	C    	F11+Alt

5    	F12         	D    	F1+Alt

6    	F12+Shift   	E    	F2+Alt

7    	F12+Ctrl    	F    	Right+Alt+Shift

The accelerator key is assigned to a particular command if the mask is immediately followed by its index.


Setup: Install - Options Mask

When defining an application or a document there are eight YES/NO options available. These options are specified in a form of a binary mask starting with the "$" character and immediately followed by a sequence of eight digits: 0 or 1. The meaning of the options from left to right is the following:

1 	Append to the existing window (if it exits)?

2 	Is this a DOS application?

3 	Does the Main File file apply as INPUT?

4 	Save the modified INPUT?

5 	Copy the INPUT (or a selected text) to the Clipboard?

6 	Does this application always require an INPUT?

7 	Is this application a document?

8 	Maximize the applications Window?

The INPUT is either the current window or the Main File.


Setup: Install - Parameters

The following INPUT parameters get translated:

Code 	Meaning 	Example

-------------------------------------------------------------------

  @P 	INPUT Path      	(c:\tex\thesis)

  @F 	INPUT File Name 	(thesis)

  @E 	INPUT File Type 	(.tex)

  @p 	Current Path      	(c:\tex\thesis)

  @f 	Current File Name 	(chap1)

  @e 	Current File Type 	(.tex)

  @M 	Main File: Full 	(c:\tex\thesis\thesis.tex)

  @m 	Main File: Path 	(c:\tex\thesis)

  @I 	Initialization File: Full

  @i 	Initialization File: Path

  @L 	Current Line Number


Application's Input

Setup: Application's Input

The INPUT is either the current window or the Main File in the case when the Main File is Enabled and the application is installed with the Main File Option ON.

See also:

Options/Project Menu

Options Mask


Setup: Install - Examples

%Utilities: Utilities Menu

>$111101013 - &AMS-LaTeX

c:\tex\bin\tex.pif &latex @P @F @E

TEX

>$111101012 + &BiBTeX

c:\tex\bin\bibtex.pif @P @F @E

BIBTEX

>$110101015 + &Spell Check

c:\tex\spell\spell.pif @P @F @E

SPELL

; Preview at the Current Line (Search)

>$00100001F - &Preview

c:\tex\dviwin\dviwin -1 -s '@L @p\@f@e' @P\@F

DVI Driver - @P\@F.dvi

See the file WINEDT.DAT for more examples.


Setup: Errors

Errors in the initialization file will likely result in a misbehavior of the program. WINEDT displays a message whenever it encounters an error in the initialization file. However, fixing the error may require some ingenuity on your side. Before making any changes make sure that you understand the significance of your modification. You are strongly advised to make only one change at the time.

Whenever WINEDT is editing its initialization file it makes a backup copy before saving the changes (regardless of the Backup File Option). If there are problems after the modification you should restore the initialization file from its backup. Comparing the backup copy with the modified file might help fixing the error.


Setup: Hints

You will probably want to make only minor changes to the initialization files provided with this distribution of WINEDT. Please, read this help and take a look at the file WINEDT.DAT.

It is recommended that the DOS utilities get invoked through ".PIF" and ".BAT" files. The files TEX.PIF,TEX.BAT and ERASE.PIF,ERASE.BAT provide the examples on how to install certain DOS applications with WINEDT.

Windows 95 provides several means to activate an application. Using Windows Explorer you can create shortcuts to WINEDT running in different modes. You may also associate WINEDT with certain file types...


The file WINEDT.DAT is included in this distribution and it contains plenty of examples regarding the installation of the most common applications.


Miscellaneous

WINEDT was originally developed under Windows 3.1. This release is modified for Windows 95.

Here is a few hints on how to get the best out of WINEDT 95.

Associated File Types

Shortcuts and Icons

Cancel and Pause

Printing

Colors

For more examples see WINEDT.DAT.


Associate

Associated File Types

If you decide to use WINEDT as a text editor it is useful to associate it with the files having certain extension. This way WINEDT can be activated by double-clicking the associated file while browsing your computer. Windows Explorer lets you associate WINEDT with certain file types through the:

View / Options... / File Type  Command

(an improved equivalent of File Manager's Associate Command in Windows 3.1).


Shortcuts and Icons

If you are writing papers or thesis using TeX you may create a folder containing the documents you are currently working on. Windows 95 lets you create shortcuts to a utility. Using this Windows Explorer's feature you can add WINEDT to your TeX (or any other Start Menu group). When defining a shortcut you can also change an ICON for different modes.

Examples:

      winedt.exe -E=wedtex.ini -C=WINEDT_-_TEX

      winedt.exe -E=wedtxt.ini -C=E-Mail

      winedt.exe -C=MEMO memo.txt

      winedt.exe


Cancel and Pause

Some WINEDT actions (such as Replace All with No Prompt or Reading a huge file with little memory) can sometimes take a long time. For your convenience it is possible to cancel such actions by pressing Ctrl+C or Ctrl+Break.

It is also possible to temporarily freeze the program by pressing Pause key. Pressing this key again will resume the action. Those two features apply whenever the status line displays the message "Working" or "Locked". After Canceling the last action you may want to Undo its effect using the Undo Command in Edit Menu.

It is hardly ever needed to Cancel an Editing Action.


Printing

WINEDT was designed in order to make typesetting the TeX documents easy in Windows environment. Since there is hardly any need to print the source TeX documents WINEDT does not have a built in command for printing. However, the user can install a utility that can print a file from a disk, or use a DOS Print command, or employ some other Window's application to print a text file.

The initialization files included with this distribution use Window's WRITE for printing. A command for printing puts the text into the Clipboard and invokes WRITE.EXE. The user can paste the text as Write's document and print it through Write's Print Command.

Note: there is no need to save the WRITE document.

Note: Windows 95 substitutes Write with WordPad.


Colors

You can change the colors of the normal and selected text by modifying the "%Select:" group in the initialization file.

This distribution includes a utility "wedcol.exe" that can be used to display possible selections.

See the file WINEDT.DAT for more details.


Highlighting

Syntax Highlighting

WINEDT 95 [Release 1.d] supports Syntax Highlighting.

The list of reserved words and symbols is determined in the initialization file. This distribution includes a utility "wedcol.exe" that can be used to display possible text colors assigned to particular words or symbols.

The file WINEDT.DAT contains examples on how to customize Syntax Highlighting.